README Contents
============================================
1.  Introduction
2.  System Requirements
3.  Release Notes
4.  Features and Its Usage
5.  Known Issues and Bug Reporting
6.  License Agreement
7.  3rd party software

********************************************************************************************************************************************************************************************************

1.  Introduction
============================================
This README file contains release notes for the Intel(R) Modern Standby IPF Extension Provider, description and usage of all the features, any problems or issues that were known at the time of shipment.


Intel(R) Modern Standby IPF Extension Provider Overview:
--------------------------------------------
Intel(R) Modern Standby IPF Extension Provider (ModsProvider.dll) is a dynamic link library which uses the IPF Framework and helps to expose the Modern Standby related data of the platform.

2.  System Requirements
============================================

a. Microsoft® Windows 11 Desktop OS (Build 22000.100 and above)
b. The utility supports the following microprocessors:
    (i)   Intel® Core Processor Line Code name MeteorLake Processor
    (ii)  Intel® Core Processor Line Code name LunarLake Processor
    (iii) Intel® Core Processor Line Code name ArrowLake Processor
    (iv) Intel® Core Processor Line Code name PantherLake Processor
    (v) Intel® Core Processor Line Code name WildcatLake Processor
    (vi) Intel® Core Processor Line Code name NovaLake Processor
    (vii) Intel® Core Processor Line Code name ArrowLake refresh Processor

c. IPF Extensible (V2.2.10204.7) Framework should be installed and available on the target system.


3.  Release Notes
============================================
Release 03.04.1009 (September 21, 2026)

    Feature Added:
    N/A

    Feature Changed / Modified:
    N/A

    Feature Deprecated:
    N/A

    Feature Removed:
    N/A

    Issues Fixed:
    - [System Data] SoCThermal returns incorrect effective frequency data (HSDES# 22023186836)
    - A command window is briefly displayed when accessing one of the IPF PSD providers (HSDES# 22023393463)

    Release 03.04.1009 — itemized changes (description, reason, references):
    1. SoCThermal returns incorrect effective frequency data
       Reason: Frequency Lib correction for effective frequency reporting.
       Notes: HSDES# 22023186836.
    2. A command window is briefly displayed when accessing one of the IPF PSD providers
       Reason: Suppressed console window flash during provider Lib initialization.
       Notes: HSDES# 22023393463.

Release 03.04.1008 (September 7, 2026)

    Feature Added:
    N/A

    Feature Changed / Modified:
    - NVL PV Release: NVL XML files updated — public XMLs picked up from Intel-PMT/xml/NVL at main (intel/Intel-PMT)
    - NULL data issues fixed for NVL/WCL/PTL Platforms (JIRA# CPT6-46319)
    - [System Data] SoCThermal and PMT provider initialization load-time improvements — reduced provider Load time for NVL KPI (HSDES# 22023113239)
    - License update to Intel OBL Tools License Agreement for End User deployment

    Feature Deprecated:
    N/A

    Feature Removed:
    N/A

    Issues Fixed:
    - Namespace NULL data issue for Platform.SOC.Thermal.CurrentTemperature.IA node — Dell reported issue on PTL (HSDES# 15019157539)
    - PerfMon Fix for Namespace TotalIdleTime is not consistent (JIRA# IPFT-13779)
    - PerfMon Provider NPU IPF Read - leads to high power consumption — WinPerf Lib fix (HSDES# 16029063218)
    - PerfMon Provider CopyEngineUsage & ComputeEngineUtilization return NULL for NPU (HSDES# 14026121493)
    - SocThermal Provider - core indexing should match with GetLogicalProcessorInformationEx (JIRA# CPT6-46381)
    - PMT Provider - NVL Sampler issue (JIRA# CPT6-45865); PMT Aggregator DieCx values are incorrect (JIRA# CPT6-45739) — PMTLib fix
    - [System Config] IPF KPI Tool Failures — NULL value fixes and WarnList updates (HSDES# 22022418719)
    - [PerfMon] IPF KPI Tool Failures — NULL value fixes and WarnList updates (HSDES# 22022418488)
    - [PMT Provider] IPF KPI Tool Failures — NULL value fixes and WarnList updates (HSDES# 22022416844)
    - [[DELL][ARL][Sanctuary]behaviors are different between different IPF/DTT drivers][PRI-Driver Restart issue] — PRI driver shall not request restart (HSDES# 14026601290)
    - With IPF PSD installed, IMSConsole crashes immediately when switching test configuration (HSDES# 22023192037)
    - [PTL][NVL-Hx] PMT Provider crash: double free in PMTProvider!ProviderApiDestroy during teardown cleanup (HSDES# 16031499978)
    - [PTL][NVL-Hx][ModsProvider] ProviderHost.exe crash: access violation in DevStackLib.dll (modsprovider_sw.inf package) (HSDES# 16031500512)
    - SoCThermal segment fault (HSDES# 22023171360)
    - SoCThermal returns incorrect effective frequency data — Frequency Lib updated to handle hybrid core frequency (HSDES# 22023186836)
    - [System Data] PMT Provider causing non-admin clients to get exceptions when calling API functions (HSDES# 22022080716)

    Release 03.04.1008 — itemized changes (description, reason, references):
    1. NVL PV Release — NVL XML files update
       Reason: Align PMT telemetry descriptors with NVL product validation.
       Notes: Public XMLs from Intel-PMT/xml/NVL at main (intel/Intel-PMT).
    2. Namespace NULL for Platform.SOC.Thermal.CurrentTemperature.IA
       Reason: Dell-reported issue on PTL.
       Notes: HSDES# 15019157539.
    3. PerfMon namespace TotalIdleTime inconsistent
       Reason: Dell-reported inconsistency.
       Notes: JIRA# IPFT-13779.
    4. PerfMon NPU IPF read causes high power consumption
       Reason: WinPerf library fix.
       Notes: HSDES# 16029063218.
    5. SoC Thermal core indexing vs. GetLogicalProcessorInformationEx
       Reason: Correct logical/efficient core mapping.
       Notes: JIRA# CPT6-46381.
    6. PMT NVL Sampler issue; PMT Aggregator DieCx values incorrect
       Reason: PMTLib correction.
       Notes: JIRA# CPT6-45865, JIRA# CPT6-45739.
    7. [System Config] IPF KPI tool failures
       Reason: NULL value fixes; WarnList updates.
       Notes: HSDES# 22022418719.
    8. [PerfMon] IPF KPI tool failures
       Reason: NULL value fixes; WarnList updates.
       Notes: HSDES# 22022418488.
    9. [PMT Provider] IPF KPI tool failures
       Reason: NULL value fixes; WarnList updates.
       Notes: HSDES# 22022416844.
    10. [DELL][ARL][Sanctuary] IPF/DTT driver behavior — PRI driver restart
        Reason: PRI driver shall not request restart.
        Notes: HSDES# 14026601290.
    11. BDBA Libxml2 issue
        Reason: Update libxml2 to latest version.
        Notes: HSDES# 14027949139.
    12. IMSConsole crash when switching test configuration (IPF PSD installed)
        Reason: Crash fix.
        Notes: HSDES# 22023192037.
    13. [PTL][NVL-Hx] PMT double free in ProviderApiDestroy during teardown
        Reason: Crash fix.
        Notes: HSDES# 16031499978.
    14. [PTL][NVL-Hx][ModsProvider] ProviderHost.exe AV in DevStackLib.dll
        Reason: Crash fix (modsprovider_sw.inf package).
        Notes: HSDES# 16031500512.
    15. SoC Thermal segment fault
        Reason: Segment fault fix.
        Notes: HSDES# 22023171360.
    16. SoC Thermal incorrect effective frequency
        Reason: Frequency Lib hybrid-core handling.
        Notes: HSDES# 22023186836.
    17. [System Data] SoC Thermal and PMT provider init KPI / Load time
        Reason: Provider Load time exceeded NVL KPI targets.
        Notes: HSDES# 22023113239 — deferred PMT aggregator parse, process-wide SoC shared init, lazy Freq/Events, warm reload when provider DLL stays mapped; KPI validated on NVL TestClient scenarios.
    18. PMT Provider exceptions for non-admin API callers
        Reason: Permission-safe API path.
        Notes: HSDES# 22022080716.
    19. License update
        Reason: End-user deployment terms.
        Notes: Intel OBL Tools License Agreement.

    Also in this release: NULL data NVL/WCL/PTL (JIRA# CPT6-46319); PerfMon NPU CopyEngineUsage & ComputeEngineUtilization NULL (HSDES# 14026121493).

    Security Issues Fixed:
    - BDBA Libxml2 issue fixed — libxml2 updated to latest version (HSDES# 14027949139)

Release 03.04.1007
    1) Implemented PCD Capabilities as part of PMT Provider for NVL
    2) NVL Beta Release
    3) Memory leak fixes
    4) Fix for NPU data reporting NULL issue
    5) IPF Exception fixed for ModS for first time execution due to missing SleepStudy files

Release 03.04.1005
    1) NVL compliant release 

Release 03.02.1001
    1) WCL compliant release 

Release 03.01.1002
    1) Fix added to execute in multithreaded environment
    2) IPF SDK changed to V2.2.10204.7

Release 03.01.1001
    1) Changed GUID and attachment node.
    2) LNL and ARL PV Release of the provider package built with IPF SDK V2.1.10105.19.

Release 02.01.1002
    1) Fixed the issue of "The system was unable to find the specified registry key or value".
   
Release 02.01.1001
    1) Enabled LNL/ARL platforms support.
    2) for MTL/ARL systems, IPF Core (V1.0.11403.38401) and Extensible (V2.1.10102.8) Framework should be installed and available on the target system.
    3) For LNL systems, IPF Core (V1.0.11461.38215) and Extensible (V2.1.10161.5) Framework should be installed and available on the target system.

Release 01.01.1003
   1) Fix for GUID Mismatch
        (i)  Platform.System.State.Sleep has been updated to {90C746B8-366E-4A19-B881-DA9910A2083D}
        (ii) Platform.System.State.Hibernate has been updated to {A30E5E84-0BF8-4090-B00A-7DE98AFA610A}
   2) Updated the IPF SDK version to V2.1.10161.5
   3) Fixed MTL bug : "Got IpfException when accessing the namespace: Failed to validate against JSON schema: data: At  of 0 - unexpected instance type". Issue was on Platform.System.State.Debug for YellowBangDevice ,due to special character present in DeviceName. 

Release 01.01.1002
   1) Fix for InfVerif issue for DCH Compliance check to be passed
   2) Updated the IPF SDK version to V2.1.10100.37

Release 01.01.1001
    Initial Release of Intel(R) Modern Standby IPF Extension Provider with below data from the system.
        1) Sleep Study Top Offenders
        2) Yellow Bang Devices
        3) Adaptive Hibernate related Settings    

4.  Features and Its Usage
============================================

The Intel® Modern Standby IPF Extension Provider includes the Provider DLL and INF files for installation. The Modern Standby Provider reads the Sleep Study top offenders, Yellow Bang devices and Adaptive hibernate settings of the system.

Please refer the Intel® Innovation Platform Framework Namespace User Guide for the list of capabilities supported by this provider.
       Document Number: 732035 
       File Download URL: https://cdrdv2.intel.com/v1/dl/getContent/732035 

To install, register and use this provider with the IPF Framework, follow below steps.
        a. Open Command prompt in Administrator mode
        b. CD to "Intel(R) Modern Standby IPF Extension Provider" folder
        c. Run below commands
                pnputil /add-driver ModsProvider_ext.inf /install
                pnputil /add-driver ModsProvider_sw.inf /install
                
To uninstall the provider, follow below steps.
        a. Open Command prompt in Administrator mode
        b. Run below command and get the <oem#.inf> filenames associated with ModsProvider_ext.inf and ModsProvider_sw.inf.
                pnputil /enum-drivers
        c. Once the <oem#.inf> filenames are obtained, run below command for both the <oem#.inf> files
                pnputil /delete-driver <oem#.inf> /uninstall


5.  Known Issues and Bug Reporting
============================================
a. Mod-S provider does not provide desired output within defined time on MTL-M platform. This issue will be fixed in next release.
b. To report a bug on this utility, please submit the bug report to your Intel Field Representative.


6.  License Agreement:
============================================
This ReadMe file as well as the software described in it is furnished under license and may only be used or copied in accordance with the terms of the license. The information in this manual is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Intel Corporation. Intel Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this document or any software that may be provided in association with this document.

Except as permitted by such license, no part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means without the express written consent of Intel Corporation. 
Information in this document is provided in connection with Intel products. No license, expressed or implied otherwise, to any intellectual property rights is granted by this document. Except as provided in Intel's Terms and Conditions of Sale for such products, Intel assumes no liability whatsoever, and Intel disclaims any express or implied warranty, relating to sale and/or use of Intel products including liability or warranties relating to fitness for a particular purpose, merchantability, or infringement of any patent, copyright or other intellectual property right. Intel products are not intended for use in medical, lifesaving, or life sustaining applications. Intel may make changes to specifications and product descriptions at any time, without notice.
Copyright (C) 2023 Intel Corporation. All rights reserved.

Intel is a trademark or registered trademark of Intel Corporation or its subsidiaries in the registered trademark of Intel Corporation or its subsidiaries in the United States and other countries.


7.  3rd party software:
============================================

    No Third-party components are shipped with this provider.

********************************************************************************************************************************************************************************************************
*Third-party brands and names are the property of the respective owners.
